Skip to main content

mcpServer

MCPServer Model​

Represents a Model Context Protocol (MCP) server configuration with connection details and status information.

id (integer, ReadOnly)​

Unique identifier for the MCP server. Automatically assigned by the system.

name (string) Required​

Name of the MCP server. Minimum 1 character.

description (string, Optional)​

Description of the MCP server. This field is nullable.

url (string, URI) Required​

Server URL for connection. Maximum 200 characters, minimum 1 character.

headers (object, Optional)​

HTTP headers for server connection. Header values are stored securely and are returned masked as null in responses.

protocol_version (string, Optional)​

MCP protocol version. Maximum 20 characters, minimum 1 character.

client_name (string, Optional)​

Name of the client connecting to the server. Maximum 100 characters, minimum 1 character.

client_version (string, Optional)​

Version of the client. Maximum 20 characters, minimum 1 character.

active (boolean, Optional)​

Whether this server is currently active.

auth_type (string, Optional)​

Authentication type for the MCP server.

  • Enum: none, headers, oauth2

oauth_config (object, Optional)​

OAuth configuration and discovery metadata for OAuth-enabled MCP servers.

oauth_client_secret (string, Optional, Write-only)​

OAuth client secret. Stored securely and never returned in responses.

created_at (string, date-time, ReadOnly)​

Timestamp when the server was created. Automatically set by the system.

updated_at (string, date-time, ReadOnly)​

Timestamp when the server was last updated. Automatically maintained by the system.

Example​

{
  "id": 0,
  "name": "string",
  "description": "string",
  "url": "string",
  "headers": {},
  "protocol_version": "string",
  "client_name": "string",
  "client_version": "string",
  "active": true,
  "auth_type": "none",
  "oauth_config": {},
  "created_at": "2025-05-28T12:34:00.601Z",
  "updated_at": "2025-05-28T12:34:00.601Z"
}